Wouldn't it be relevant to use afetchQueryAndGetFromState here? This would look more like a useQuery by retrieving the cache if it exists

Sorry I made the edit this morning but did not pushed it yet seems some discussion are still in progress

I pushed theme here, but CI will fail due to types error: https://github.com/cozy/cozy-client/compare/0af2607eabfdcc3fe08b06f560166123a320b91d..c44f83a86d7b55513e3bdffbbff1ca9edf62cbb6

(cf #931 et l'autre issue liée pour pourquoi cette méthode pour le moment)

I'm thinking about this default fetch policy. Maybe it is too long ? I do not have any use case now to explain (😅) but I have the feeling that with 1 hour we can get outdated setting value where we de not want outdated setting value.

Maybe it should be short but enough to avoid 2 requests when doing a getSetting + saveAfterFetchSetting? Like 10 seconds?

Oh you already changed it in a next commit perfect.

Maybe having an array of keys could have been useful

Why not, I'll try to add this

I have this in my mind since yesterday but I'm struggling on choosing the best API.

Declaration

For the declaration I imagine the following possibilities:

Use same hook for both single string param or multiple array param

const { value } = useSetting('home', 'mysetting')
// value = 'some_value'

const { value } = useSetting('home', ['mysetting1', 'mysetting2'])
// value = {
//   mysetting1: 'some_value_1',
//   mysetting2: 'some_value_2'
// }

Use a different hooks for single and multiple params

const { value } = useSetting('home', 'mysetting')
const { values } = useSettings('home', ['mysetting1', 'mysetting2'])

Use an object instead of an array to declare default values (but I we may remove the default value thing, I think I can forget this option)

const { value } = useSetting('home', 'mysetting')
const { values } = useSettings('home', {
  mysetting1: 'defaultValue1',
  mysetting2': 'defaultValue2'
})

Mutation

Mutation is getting harder to approach

Should we return multiple save methods for each key?

const { value, savemysetting1,  savemysetting2} = useSetting('home', ['mysetting1', 'mysetting2'])

savemysetting1('value1')
savemysetting2('value2')

or

const { value, save } = useSetting('home', ['mysetting1', 'mysetting2'])

save.mysetting1('value1')
save.mysetting2('value2')

This constrains the API and so prevents errors, but sadly this also prevents mutating multiple settings at once

Should we return a save that takes an objet?

const { value, save} = useSetting('home', ['mysetting1', 'mysetting2', 'mysetting3'])

savemysetting1({
  mysetting1: 'value1',
  mysetting3: 'value3'
})

This allow mutating multiple settings at once, but this makes the API less contraint and I'm wondering if we should allow inserting new keys or make a code that throw a specific error is the method is called with keys that are not present in the initial array?

I made a proposal here: dcb23c5

(I still have to update documentation)

Usage would be:

Hook

const { value, save } = useSetting('home', ['mysetting1', 'mysetting2'])
...

// ✅ Valid
save({
  mySetting1: 'newValue1',
  mySetting2: 'newValue2'
})

// ✅ Valid
save({
  mySetting1: 'newValue1'
})

// ❌ Not valid because new key inserted
save({
  mySetting1: 'newValue1',
  mySetting2: 'newValue2',
  mySetting3: 'newValue3'
})

Get

const result = await client.getSetting('home', ['mysetting1', 'mysetting2'])

console.log(result.mysetting1)
console.log(result.mysetting2)

Save

// With raw value
await client.saveAfterFetchSetting(
  'instance',
  {
    some_instance_key: 'some_new_instance_value',
    some_instance_key2: 'some_new_instance_value_2'
  }
)


// With a method
await client.saveAfterFetchSetting(
  'instance',
  currentValue => ({
    ...currentValue,
    some_instance_key: currentValue.some_instance_key + 1,
    some_instance_key2: 'some_new_instance_value_2'
  }),
  ['some_instance_key']
)

When using a method we must pass a setterKeys parameters so the save method can still extract correct values. I would prefer not to have this parameter but I did not find a better way 😕

Note that I typed those methods to prevent mistakes when using them. Here is how the linter and the auto-complete features behave:

I updated the cozy-home PR with the new multiple-settings API: linagora/cozy-home@e20239d

👍👍